home *** CD-ROM | disk | FTP | other *** search
/ Popular Request / By Popular Request (Arsenal Computer)(SysOptics Distribution System).ISO / amiga1 / aq_122.lha / amiqwk / AmiQWK.DOC < prev    next >
Text File  |  1992-11-17  |  14KB  |  354 lines
  1.  
  2.  
  3.  
  4.                       AmiQWK - The Amiga .QWK Reader
  5.      ----------------------------------------------------------------
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                                   AmiQWK:
  20.  
  21.                         The Amiga .QWK Mail Reader.
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.        This document, the program AmiQWK, and all related files are
  58.                        Copyright ⌐ 1992 Jim Dawson.
  59.  
  60.                            All rights Reserved.
  61.  
  62.    REMEMBER: YOUR SHAREWARE CONTRIBUTIONS ENCOURAGE FUTURE DEVELOPMENT!
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.                     Disclaimer and other legal stuff...
  70.  
  71.           This program is provided 'as is'  without  any  warranty  of
  72.      any kind. Use it at your own  risk.  The  programmer  assumes  no
  73.      responsibility for any damages or  losses  directly,  indirectly,
  74.      or otherwise resulting from this program or  it's  usefulness  or
  75.      suitability to any application.
  76.  
  77.                                Distribution
  78.  
  79.           This  program  is  copyrighted  but  freely   distributable.
  80.      Permission is hereby given to  distribute  AmiQWK  provided  that
  81.      all files in the distribution are distributed in their  original,
  82.      unmodified form other than compression using an archival  utility
  83.      such as LHArc for distribution  purposes.  This  program  may  be
  84.      included in public domain/shareware libraries including the  Fred
  85.      Fish collection provided that no fee is placed  on  this  program
  86.      other than a nominal copying fee.
  87.  
  88.                                Registration
  89.  
  90.           If you use this program, a voluntary shareware  contribution
  91.      of $5.00 in U.S. funds would be greatly appreciated. Please  send
  92.      your contributions to the address at the end  of  this  document.
  93.      At this time I do  not  have  the  resources  to  keep  track  of
  94.      registrations and send out upgrades (and besides, I would  rather
  95.      be writing code anyway...) so I cannot guarantee  that  you  will
  96.      get anything other  than  my  gratitude  for  your  contribution.
  97.      However, your contribution will help to insure  that  development
  98.      on AmiQWK will continue.
  99.           If you are unable or unwilling  to  send  U.S.  funds,  feel
  100.      free to send me a box of floppy disks  (either  with  or  without
  101.      software on them, but no pirated stuff please), or anything  else
  102.      of comparable value.
  103.  
  104.  
  105.                                About AmiQWK.
  106.  
  107.           AmiQWK is an off-line  mail  reader  for  .QWK  format  mail
  108.      packets.  AmiQWK allows you to download  messages  from  any  BBS
  109.      that uses a .QWK format mail packer (such as TomCat for  Wildcat!
  110.      BBS and MarkMail for PCBoard).
  111.           Using a mail reader  such  as  AmiQWK  allows  you  to  read
  112.      messages off-line at your own pace and enter messages  using  any
  113.      text editor or word processor capable of saving ASCII text  (i.e.
  114.      no imbedded formatting codes). All  of  the  messages  you  enter
  115.      will be packed into a file to be uploaded the next time you  call
  116.      the BBS.
  117.  
  118.                             Installing AmiQWK.
  119.  
  120.           To use AmiQWK, the REQTOOLS.LIBRARY must  be  in  the  LIBS:
  121.      directory. To install the REQTOOLS.LIBRARY,  click  on  the  icon
  122.      labeled 'Install'. The installation script  will  determine  what
  123.      version of the library you need  and  will  install  it  in  your
  124.      LIBS: directory.
  125.  
  126.           In addition to the files in  the  AmiQWK  distribution,  you
  127.      will need to obtain any archival utilities you intend to use  for
  128.      compression and de-compression of  mail  packets.  At  this  time
  129.      AmiQWK recognizes mail packets packed with 'ZIP' 'LHArc/LHA'  and
  130.      'ZOO'. You will also need a text editor  to  edit  messages.  Any
  131.      editor or word processor capable of saving files in ASCII  format
  132.      (i.e. no imbedded formatting commands) can be used, such  as  the
  133.      'ED' or 'MEMACS' editors that come on the workbench  distribution
  134.      disks.
  135.  
  136.           You may also wish to obtain an IBM style font for  use  with
  137.      AmiQWK as some messages may  contain  IBM  style  extended  ASCII
  138.      characters. AmiQWK allows the use of any fixed-width8 point  font
  139.      for message text. See the section  on  the  configuration  editor
  140.      for more information on fonts.
  141.  
  142.                               Running AmiQWK.
  143.  
  144.           On-line context sensitive help is available by pressing  the
  145.      'Help' of 'F1' keys for most of AmiQWK's operations.
  146.  
  147.           Before you run AmiQWK, you will  need  to  call  a  BBS  and
  148.      download a mail  packet.  Check  the  on-line  documentation  for
  149.      instructions on how to operate the mail packer.
  150.  
  151.           Once you have downloaded a mail packet you are ready to  run
  152.      AmiQWK. AmiQWK can be started from the CLI by tying  'AmiQWK'  in
  153.      the directory where AmiQWK resides or by clicking on  the  AmiQWK
  154.      icon from the  Workbench.  After  AmiQWK  has  loaded,  a  custom
  155.      screen will  open  containing  4  gadgets  labeled  'Read  Mail',
  156.      'Config AmiQWK','About AmiQWK' and 'Quit'.  The  first  time  you
  157.      run the program, you will need to configure  the  program.  Click
  158.      on the gadget labeled 'Config AmiQWK' or press the 'C' key.  This
  159.      will open a configuration screen where you can  customize  AmiQWK
  160.      to your system. See the section on the Configuration  Editor  for
  161.      more information on configuring AmiQWK to your system.
  162.  
  163.           Now that you have AmiQWK configured to your system, you  can
  164.      read messages. Click on the 'Read Messages' gadget or press  'R'.
  165.      A file requester will then appear, and  if  you  set  the  packet
  166.      directory in the configuration editor properly,  the  packet  you
  167.      just downloaded should appear in the file requester. Select  this
  168.      file by either double-clicking on the  file  name  or  by  single
  169.      clicking on the file name and clicking on the 'Ok' gadget.  After
  170.      you have selected the mail packet, the Workbench screen  will  be
  171.      brought to the front and the files contained in the  mail  packet
  172.      will be extracted to a work  directory  created  when  AmiQWK  is
  173.      run. AmiQWK will then scan  the  mail  packet  for  messages  and
  174.      information about the BBS. While this processing  takes  place  a
  175.      window will open showing the amount of  progress  that  has  been
  176.      made. If a reply packet exists from an  earlier  AmiQWK  session,
  177.      it will also be extracted and read. If you wish  to  stop  AmiQWK
  178.      from processing the current mail packet  you  may  click  on  the
  179.      'Abort' gadget in the progress window  and  return  to  the  main
  180.      screen.
  181.  
  182.           After AmiQWK has  processed  the  entire  packet,  the  main
  183.      control panel will disappear and will be replaced with  a  header
  184.      at the top of the screen and message  text  at  the  bottom.  The
  185.      header will contain information such as who the message is  from,
  186.      who it is to, what it is  about,  the  name  and  number  of  the
  187.      conference the message is from, etc. Below  the  header  will  be
  188.      the message text. If the text of the message is long  enough  all
  189.      of it may not be visible. The following keys  can  be  used  when
  190.      reading messages.
  191.  
  192.               Up Arrow       -    Scroll message up 1 line.
  193.               Down Arrow     -    Scroll message down 1 line.
  194.               Left Arrow     -    Read Previous Message.
  195.               Right Arrow    -    Read Next Message.
  196.  
  197.      2,4,6 and 8 on the numeric keypad can also be used  in  place  of
  198.      the arrow keys.
  199.  
  200.           Home           -    Move to top of message text.
  201.           End            -    Move to end of message text.
  202.           PgUp           -    Scroll up 1 page of message text.
  203.           PgDn           -    Scroll down 1 page of message text.
  204.  
  205.      Home, End, PgUp, and PgDn are 8, 3,  7,  and  1  on  the  numeric
  206.      keypad respectively.
  207.  
  208.         C              -    Select New Conference.
  209.         R              -    Reply to current message.
  210.         E              -    Enter a new message. Same as 'R' except
  211.                                 Message text is not quoted.
  212.         Q              -    Quit to main menu.
  213.  
  214.      All keys are case-insensitive.
  215.  
  216.           When you are done reading messages, either  after  you  move
  217.      past either the first or last message  or  by  pressing  the  'Q'
  218.      key, your replies will be packed and you will return to the  main
  219.      screen.
  220.  
  221.                               Configuration.
  222.  
  223.           When you click on the 'Configure  AmiQWK'  gadget  or  press
  224.      the 'C' key from the main control panel, a  configuration  editor
  225.      window will appear. On this  window  there  are  several  gadgets
  226.      which will edit the following .
  227.  
  228.      Message Text Font: AmiQWK allows you to specify  any  fixed-width
  229.           8 point font for displaying message text. You  may  wish  to
  230.           use an IBM style font for message  text,  as  some  messages
  231.           will contain IBM extended ASCII characters. Enter  the  name
  232.           of  the  font  you  wish  to  use,  including  the   '.FONT'
  233.           extension.
  234.  
  235.      Reply Quote Prefix: When replying to a message, the text  of  the
  236.           message you are replying to is  quoted  in  your  reply.  In
  237.           order to set the  quoted  text  apart  from  your  reply,  a
  238.           prefix  is  added  before  each  line.  You  can  enter  any
  239.           character string up to 10 characters as your quote prefix.
  240.  
  241.      Edit Palette: Clicking on this gadget will  bring  up  a  palette
  242.           requester allowing you to  change  the  colors  that  AmiQWK
  243.           uses.
  244.  
  245.      Edit Compression Command Strings:  Clicking on this  gadget  will
  246.           bring up a window with 3 string gadgets labeled LHArc,  ZIP,
  247.           and ZOO. Here you can edit the command strings  to  compress
  248.           reply packets for each of the compression methods.
  249.  
  250.      Edit Compression Command Strings: Clicking on  this  gadget  will
  251.           bring up a window with 3 string gadgets labeled LHArc,  ZIP,
  252.           and ZOO. Here you can edit the command  strings  to  extract
  253.           mail packets for each of the compression methods.
  254.  
  255.      Editor: This is the editor you wish to use. You may also  include
  256.           the path if needed.
  257.  
  258.      Work Directory: This is the directory where AmiQWK  will  extract
  259.           mail packets to.
  260.  
  261.                                  WARNING!
  262.           THE WORK DIRECTORY SHOULD NOT BE AN EXISTING DIRECTORY!
  263.                ALL FILES IN THIS DIRECTORY WILL BE DELETED.
  264.             AmiQWK WILL CREATE THIS DIRECTORY AS IT IS NEEDED.
  265.  
  266.      Packet Directory:  This is the directory where AmiQWK  will  look
  267.           for mail packets. Normally this will be the  directory  your
  268.           term program uses for downloads.
  269.  
  270.      Reply Directory:  This is the directory where AmiQWK  will  store
  271.           and look for  reply  packets.  Normally  this  will  be  the
  272.           directory your term program uses for uploads.
  273.  
  274.      Cancel: Discard all changes  and  return  to  old  configuration.
  275.           Returns to the AmiQWK control panel.
  276.  
  277.      Save:  Saves  current  configuration  as  default.  Configuration
  278.           information is stored in the file S:AMIQWK.DEFAULTS.
  279.  
  280.      OK: Use the new configuration and return to  the  AmiQWK  control
  281.           panel.
  282.  
  283.  
  284.                               Hints and Tips
  285.  
  286.           If you use Zmodem for file  transfers,  do  not  use  Zmodem
  287.      Resume when downloading .QWK packets. If you have an  old  packet
  288.      in your download directory when downloading  a  new  one,  Zmodem
  289.      Resume assumes that the old packet is a a portion of  an  aborted
  290.      download and tries to  resume  the  transfer.  The  result  is  a
  291.      corrupted mail packet.
  292.  
  293.           AmiQWK will create a work directory if it does  not  already
  294.      exist. When selecting a work directory (See the  section  on  the
  295.      configuration editor)  make  sure  that  you  DO  NOT  SELECT  AN
  296.      EXISTING  DIRECTORY!  AmiQWK  WILL  DELETE  ALL  FILES  IN   THIS
  297.      DIRECTORY WHEN THE PROGRAM EXITS!
  298.  
  299.                                    Bugs
  300.  
  301.           Unfortunatly, I have  not  been  able  to  fully  beta  test
  302.      AmiQWK. If you find a bug in the program, please write to  me  at
  303.      the address at the end of this document. Be sure to  give  me  as
  304.      much information as possible about  your  system,  what  programs
  305.      are running allong with AmiQWK, how I can duplicate the  failure,
  306.      ect.
  307.  
  308.                            The Future of AmiQWK
  309.  
  310.           This version of AmiQWK (1.0) was intended to  be  compatible
  311.      with both Workbench 1.3 and 2.0  because  (1)  a  lot  of  people
  312.      haven't upgraded to 2.0 yet and (2) I am not yet familiar  enough
  313.      with the new 2.0 system calls. The  next  version  will  probably
  314.      work under  2.0  only,  unless  major  bugs  are  found  in  this
  315.      version. See 'FUTURE.DOC' for a list of features I  plan  to  add
  316.      in future versions.
  317.  
  318.  
  319.           AmiQWK was created on a 6MB Amiga  2000  with  a  22MHz  GVP
  320.      68030 accelerator  running  AmigaDos  2.04  using  the  following
  321.      programs:
  322.  
  323.  
  324.           SAS C v5.10b - 6.0  SAS Institute       C Compiler.
  325.           CygnusEd Pro v2.12  ASDG Inc. Text      Text Editing.
  326.           Lemmings            Psygnosis           Diversions.
  327.  
  328.                  REQTOOLS.LIBRARY written by Nico Fraεois.
  329.  
  330.                  RAWKEY/ASCII conversion routines written
  331.                          by Fabbian G. Dufoe, III.
  332.  
  333.                 Help routines written by Philip S. Kasten.
  334.  
  335.         MSBIN conversion routines and .QWK format routines based on
  336.                          routines by Jefferey Foy.
  337.  
  338.             ---------------------------------------------------
  339.             Send shareware contributions, bug reports, ect. to:
  340.  
  341.                           Snail Mail: Jim Dawson
  342.                             509 S. Madison St.
  343.                            Marion, IL. 62959 USA
  344.  
  345.                           BBS: Pooh's Corner BBS
  346.                              Carterville, IL.
  347.                               (618) 985-4747
  348.                            300-2400 BPS, 24Hrs.
  349.  
  350.                       EMail: jimdawson@cup.portal.com
  351.                              Portal: jimdawson
  352.  
  353.    REMEMBER: YOUR SHAREWARE CONTRIBUTIONS ENCOURAGE FUTURE DEVELOPMENT!
  354.